Example: Assess Request xml

Below are examples of an Assess Request for the rulebase SimpleBenefits for both the generic and specific services. The SimpleBenefits rulebase can be found in examples\rulebases\SimpleBenefits.zip.

Example Assess Request (generic)

The Assess Request needs to be wrapped in a standard SOAP Envelope, which contains a header, and a body. Lines 1-3 are the starting of the SOAP request. The body and envelope are closed on lines 28 and 29.

When the soap element is begun the namespace for the elements used in all the Determinations Server requests is imported through the declaration "xmlns:typ="http://oracle.com/determinations/server/10.4/rulebase/assess/types"".

Lines 4-27 are the assess request and are all from the Determinations Server namespace. The assess request is doing the following:

Creating a global-instance element for the global entity. This element contains the child entity element (lines 5-26).
Creating an entity element for the child entity and two child instances (lines 14-25).
In the global-instance element, specifying 2 attribute outcomes, to return with the outcome style "value-only". The outcomes being requested are eligible_low_income_allowance and eligible_teenage_allowance (lines 6-7).
In the global entity instance, setting the attribute claimant_income to the number value 13000 (lines 8-10). (Number values are used for currency and number values.)
In the global entity instance, setting the attribute claimant_public_housing_client to the Boolean value 'true' (lines 11-13).
Creating two child entity instances (child1 and child2) and setting the attribute child_age for both to the number values 16 and 8 respectively (lines 14-25).

Important Note: do not set value and specify outcome style for same attribute

Do not both set a value for an attribute and specify that attribute as an outcome in the same Assess Request. If you do this, any value set for the attribute in the Request will be ignored (in other words, only the "outcome-stlye" part of the Request will be processed for that attribute).

(The reason for this behavior is that the Response provided by the service is in the same format as the Request, to make it easier for for scenarios where you wish to call the Determinations Server repeatedly with partial data in order for it to provide you with information about what additional relevant information you need to collect).

Example Assess Request (specific)

The specific assess request for the same rulebase needs the same standard soap wrapper as the generic request above (lines 1-3, 28-29).

The namespace declaration on line 1 is for the specific service and named for (and specific to) the SimpleBenefits rulebase: "xmlns:typ="http://oracle.com/determinations/server/10.4/SimpleBenefits/assess/types"".

Lines 4-27 are the specific assess request and are all from the SimpleBenefits namespace. The assess request is setting and request exactly the same data as the generic assess request.

Creating a global instance (lines 5-26).
Creating a list-child element for the child entity and two child instances (lines 14-25).
Attribute outcomes for eligible_low_income_allowance and eligible_teenage_allowance on the global entity instance (lines 6-7).
Setting the attribute for claimant_income and claimant_public_housing_client to 13000 and 'true' respectively (lines 8-13).
Creating two child entity instances (child1 and child2) and setting the child_age attributes for both to 16 and 8 respectively (lines 15-24).

Assess Request Best Practice Tips

It is recommended you limit your Assess Request to the bare minimum of elements to return what you require. In particular:

For an attribute you are setting a value for in the Request, only provide the value, do not set the "type" and "inferred" attributes. These attributes are typically returned in the Response and cannot be set by the Request.
For an attribute you want the Response to return an outcome for, set either
- the "outcome-style", or
- (if you want different types of outcomes) both the "unknown-outcome-style" and "known-outcome-style". Note: it is not necessary or recommended that you specify all three.
Do not set the outcome style of an attribute that you are setting a value for. It should always be returned in the Response. For more information, see Important Note: do not set value and specify outcome style for same attribute.